home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / sgebrd.z / sgebrd
Encoding:
Text File  |  2002-10-03  |  7.2 KB  |  199 lines
  1.  
  2.  
  3.  
  4. SSSSGGGGEEEEBBBBRRRRDDDD((((3333SSSS))))                                                          SSSSGGGGEEEEBBBBRRRRDDDD((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SGEBRD - reduce a general real M-by-N matrix A to upper or lower
  10.      bidiagonal form B by an orthogonal transformation
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE SGEBRD( M, N, A, LDA, D, E, TAUQ, TAUP, WORK, LWORK, INFO )
  14.  
  15.          INTEGER        INFO, LDA, LWORK, M, N
  16.  
  17.          REAL           A( LDA, * ), D( * ), E( * ), TAUP( * ), TAUQ( * ),
  18.                         WORK( * )
  19.  
  20. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  21.      These routines are part of the SCSL Scientific Library and can be loaded
  22.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  23.      directs the linker to use the multi-processor version of the library.
  24.  
  25.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  26.      4 bytes (32 bits). Another version of SCSL is available in which integers
  27.      are 8 bytes (64 bits).  This version allows the user access to larger
  28.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  29.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  30.      only one of the two versions; 4-byte integer and 8-byte integer library
  31.      calls cannot be mixed.
  32.  
  33. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  34.      SGEBRD reduces a general real M-by-N matrix A to upper or lower
  35.      bidiagonal form B by an orthogonal transformation: Q**T * A * P = B. If m
  36.      >= n, B is upper bidiagonal; if m < n, B is lower bidiagonal.
  37.  
  38.  
  39. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  40.      M       (input) INTEGER
  41.              The number of rows in the matrix A.  M >= 0.
  42.  
  43.      N       (input) INTEGER
  44.              The number of columns in the matrix A.  N >= 0.
  45.  
  46.      A       (input/output) REAL array, dimension (LDA,N)
  47.              On entry, the M-by-N general matrix to be reduced.  On exit, if m
  48.              >= n, the diagonal and the first superdiagonal are overwritten
  49.              with the upper bidiagonal matrix B; the elements below the
  50.              diagonal, with the array TAUQ, represent the orthogonal matrix Q
  51.              as a product of elementary reflectors, and the elements above the
  52.              first superdiagonal, with the array TAUP, represent the
  53.              orthogonal matrix P as a product of elementary reflectors; if m <
  54.              n, the diagonal and the first subdiagonal are overwritten with
  55.              the lower bidiagonal matrix B; the elements below the first
  56.              subdiagonal, with the array TAUQ, represent the orthogonal matrix
  57.              Q as a product of elementary reflectors, and the elements above
  58.              the diagonal, with the array TAUP, represent the orthogonal
  59.              matrix P as a product of elementary reflectors.  See Further
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSGGGGEEEEBBBBRRRRDDDD((((3333SSSS))))                                                          SSSSGGGGEEEEBBBBRRRRDDDD((((3333SSSS))))
  71.  
  72.  
  73.  
  74.              Details.  LDA     (input) INTEGER The leading dimension of the
  75.              array A.  LDA >= max(1,M).
  76.  
  77.      D       (output) REAL array, dimension (min(M,N))
  78.              The diagonal elements of the bidiagonal matrix B:  D(i) = A(i,i).
  79.  
  80.      E       (output) REAL array, dimension (min(M,N)-1)
  81.              The off-diagonal elements of the bidiagonal matrix B:  if m >= n,
  82.              E(i) = A(i,i+1) for i = 1,2,...,n-1; if m < n, E(i) = A(i+1,i)
  83.              for i = 1,2,...,m-1.
  84.  
  85.      TAUQ    (output) REAL array dimension (min(M,N))
  86.              The scalar factors of the elementary reflectors which represent
  87.              the orthogonal matrix Q. See Further Details.  TAUP    (output)
  88.              REAL array, dimension (min(M,N)) The scalar factors of the
  89.              elementary reflectors which represent the orthogonal matrix P.
  90.              See Further Details.  WORK    (workspace/output) REAL array,
  91.              dimension (LWORK) On exit, if INFO = 0, WORK(1) returns the
  92.              optimal LWORK.
  93.  
  94.      LWORK   (input) INTEGER
  95.              The length of the array WORK.  LWORK >= max(1,M,N).  For optimum
  96.              performance LWORK >= (M+N)*NB, where NB is the optimal blocksize.
  97.  
  98.              If LWORK = -1, then a workspace query is assumed; the routine
  99.              only calculates the optimal size of the WORK array, returns this
  100.              value as the first entry of the WORK array, and no error message
  101.              related to LWORK is issued by XERBLA.
  102.  
  103.      INFO    (output) INTEGER
  104.              = 0:  successful exit
  105.              < 0:  if INFO = -i, the i-th argument had an illegal value.
  106.  
  107. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  108.      The matrices Q and P are represented as products of elementary
  109.      reflectors:
  110.  
  111.      If m >= n,
  112.  
  113.         Q = H(1) H(2) . . . H(n)  and  P = G(1) G(2) . . . G(n-1)
  114.  
  115.      Each H(i) and G(i) has the form:
  116.  
  117.         H(i) = I - tauq * v * v'  and G(i) = I - taup * u * u'
  118.  
  119.      where tauq and taup are real scalars, and v and u are real vectors;
  120.      v(1:i-1) = 0, v(i) = 1, and v(i+1:m) is stored on exit in A(i+1:m,i);
  121.      u(1:i) = 0, u(i+1) = 1, and u(i+2:n) is stored on exit in A(i,i+2:n);
  122.      tauq is stored in TAUQ(i) and taup in TAUP(i).
  123.  
  124.      If m < n,
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSGGGGEEEEBBBBRRRRDDDD((((3333SSSS))))                                                          SSSSGGGGEEEEBBBBRRRRDDDD((((3333SSSS))))
  137.  
  138.  
  139.  
  140.         Q = H(1) H(2) . . . H(m-1)  and  P = G(1) G(2) . . . G(m)
  141.  
  142.      Each H(i) and G(i) has the form:
  143.  
  144.         H(i) = I - tauq * v * v'  and G(i) = I - taup * u * u'
  145.  
  146.      where tauq and taup are real scalars, and v and u are real vectors;
  147.      v(1:i) = 0, v(i+1) = 1, and v(i+2:m) is stored on exit in A(i+2:m,i);
  148.      u(1:i-1) = 0, u(i) = 1, and u(i+1:n) is stored on exit in A(i,i+1:n);
  149.      tauq is stored in TAUQ(i) and taup in TAUP(i).
  150.  
  151.      The contents of A on exit are illustrated by the following examples:
  152.  
  153.      m = 6 and n = 5 (m > n):          m = 5 and n = 6 (m < n):
  154.  
  155.        (  d   e   u1  u1  u1 )           (  d   u1  u1  u1  u1  u1 )
  156.        (  v1  d   e   u2  u2 )           (  e   d   u2  u2  u2  u2 )
  157.        (  v1  v2  d   e   u3 )           (  v1  e   d   u3  u3  u3 )
  158.        (  v1  v2  v3  d   e  )           (  v1  v2  e   d   u4  u4 )
  159.        (  v1  v2  v3  v4  d  )           (  v1  v2  v3  e   d   u5 )
  160.        (  v1  v2  v3  v4  v5 )
  161.  
  162.      where d and e denote diagonal and off-diagonal elements of B, vi denotes
  163.      an element of the vector defining H(i), and ui an element of the vector
  164.      defining G(i).
  165.  
  166.  
  167. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  168.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  169.  
  170.      This man page is available only online.
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.